InvokeKCCallbackUPP

InvokeKCCallbackUPP
Header:	Keychain.h		Carbon status:	Under Evaluation

Invokes your Keychain event-handling callback function.

OSStatus InvokeKCCallbackUPP (
    KCEvent keychainEvent, 
    KCCallbackInfo *info, 
    void *userContext, 
    KCCallbackUPP userUPP
);

keychainEvent: The Keychain-related events to be received by your callback function. See “Keychain Event Constants” for a description of possible values. The Keychain Manager uses the mask you pass in the eventMask parameter of the function KCAddCallback to determine which Keychain-related events your callback will receive.
info: A pointer to a structure of type KCCallbackInfo that provides information to your callback function. Keychain Manager passes this structure in the info parameter of your callback function.
userContext: A pointer to caller-defined storage. Keychain Manager passes this value in the userContext parameter of your callback structure. Your callback function might use it to track which instance of a function is active.
userUPP: A UPP to your callback function. Keychain Manager passes this pointer to invoke your callback function.

function result: A result code.

DISCUSSION

The Keychain Manager calls the InvokeKCCallbackUPP function whenever a keychain event occurs, or when a lengthy operation is occurring, as indicated by the event mask you pass in the eventMask parameter of the function KCAddCallback. In turn, the Keychain Manager passes the event type, an information structure about the event, and a reference to the application-defined context to your callback function. For information on how to create a Keychain event-handling callback function, see KCCallbackProcPtr.

VERSION NOTES

Available beginning with Keychain 1.0.

AVAILABILITY

Under evaluation for Carbon. Available in CarbonLib 1.0 and later. Exported by CarbonLib 1.0 and later.